feat(sdk): ingredient JUMBF archives, archive metadata typing by gpeacock · Pull Request #2007 · contentauth/c2pa-rs

gpeacock · 2026-04-02T03:14:43Z

Add Builder write_ingredient_archive(ingredient_id) and add_ingredient_from_archive
Tag JUMBF archives with org.contentauth.archive.metadata (archive:type builder|ingredient)
Add labels ARCHIVE_METADATA, ARCHIVE_TYPE_BUILDER, ARCHIVE_TYPE_INGREDIENT
Add INGREDIENT_ARCHIVE_MIME; to_archive uses builder archive type
Internal ArchiveKind + working_store_sign(kind); scoped one-ingredient claim via scoped_for_ingredient_archive
Preserve parent claim thumbnail and copy assertions (exclude archive metadata & box hash); merge archive resources on import
Reader::active_archive_type for ingredient-archive checks
Test round-trip with claim thumbnail and resource merge

- Add Builder write_ingredient_archive(ingredient_id) and add_ingredient_from_archive - Tag JUMBF archives with org.contentauth.archive.metadata (archive:type builder|ingredient) - Add labels ARCHIVE_METADATA, ARCHIVE_TYPE_BUILDER, ARCHIVE_TYPE_INGREDIENT - Add INGREDIENT_ARCHIVE_MIME; to_archive uses builder archive type - Internal ArchiveKind + working_store_sign(kind); scoped one-ingredient claim via scoped_for_ingredient_archive - Preserve parent claim thumbnail and copy assertions (exclude archive metadata & box hash); merge archive resources on import - Reader::active_archive_type for ingredient-archive checks - Test round-trip with claim thumbnail and resource merge

codecov · 2026-04-02T03:22:38Z

Codecov Report

❌ Patch coverage is 81.19658% with 22 lines in your changes missing coverage. Please review.
✅ Project coverage is 77.46%. Comparing base (e0e4cc2) to head (4bc536b).
⚠️ Report is 1 commits behind head on main.

Files with missing lines	Patch %	Lines
sdk/src/builder.rs	79.43%	22 Missing ⚠️

Additional details and impacted files

@@           Coverage Diff            @@
##             main    #2007    +/-   ##
========================================
  Coverage   77.45%   77.46%            
========================================
  Files         176      176            
  Lines       44142    44256   +114     
========================================
+ Hits        34192    34284    +92     
- Misses       9950     9972    +22

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

codspeed-hq · 2026-04-02T03:23:32Z

Merging this PR will not alter performance

✅ 32 untouched benchmarks
⏩ 2 skipped benchmarks¹

_{Comparing gpeacock/archive_ingredients (4bc536b) with main (122110d)}

2 benchmarks were skipped, so the baseline results were used instead. If they were deleted from the codebase, click here and archive them to remove them from the performance reports. ↩

ok-nick · 2026-04-02T19:20:55Z

sdk/src/builder.rs

+        let json = format!(
+            r#"{{"@context":{{"archive":"https://contentauth.org/ns/archive#"}},"archive:type":"{archive_type}"}}"#
+        );
+        let archive_metadata = Metadata::new(labels::ARCHIVE_METADATA, &json)?;


What is this link supposed to point to?

ok-nick · 2026-04-02T19:24:01Z

sdk/src/builder.rs

+            .filter(|a| {
+                let (base, _, _) = parse_label(a.label());
+                base != labels::ARCHIVE_METADATA && base != labels::BOX_HASH
+            })


How come we filter for archive metadata and only box hash? If it's an archive metadata should we error since it shouldn't be there?

ok-nick · 2026-04-02T19:26:17Z

sdk/src/reader.rs

+    pub(crate) fn active_archive_type(&self) -> Option<String> {
+        let manifest = self.active_manifest()?;
+        let metadata: Metadata = manifest
+            .find_assertion(crate::assertions::labels::ARCHIVE_METADATA)
+            .ok()?;
+        metadata
+            .value
+            .get("archive:type")
+            .and_then(|v: &Value| v.as_str().map(str::to_owned))
+    }


Return enum here?

ok-nick · 2026-04-02T19:28:54Z

sdk/src/builder.rs

+    ///
+    /// For other `application/c2pa` stores, use [`Self::add_ingredient_from_reader`] or
+    /// [`Self::add_ingredient_from_stream`].
+    #[async_generic]


Hm, should we have async variants of this function? Is there any async behavior we can expect?

The progress report, maybe, in future, could become async?

ok-nick · 2026-04-02T19:31:40Z

sdk/src/builder.rs

+    /// distinguished from a full builder archive when reading with [`Self::add_ingredient_from_archive`].
+    ///
+    /// The exported manifest is **not** a lossless slice of the parent: it uses one cloned ingredient
+    /// and a fresh claim instance id; other ingredients are omitted.


What about ingredients the ingredient contains?

"and a fresh claim instance id"?

Shallow is the right contract. The compound content model in specs-core #2058 treats componentOf ingredients as references to independently signed child assets. A child's provenance chain lives in the child's manifest store, which standard ingredient handling copies into the parent. Sub-ingredients are not nested on the componentOf definition itself, they resolve from the manifest store at validation time.

write_ingredient_archive needs to carry the ingredient definition and its directly associated resources. Recursive sub-ingredient walking would conflate the ingredient reference with the manifest store history.

That said, scoped_for_ingredient_archive clones the entire resource store (self.resources.clone() at line 3357), which is broader than needed. @tmathern's suggestion to scope resources to the target ingredient and claim-level refs (thumbnail) is a tighter contract and avoids carrying unrelated sibling data.

On INGREDIENT_ARCHIVE_MIME as format (line 3356): format is removed in claim v2. The org.contentauth.archive.metadata assertion already carries archive:type, so the format field is redundant. Gating the assignment on claim_version or dropping it entirely avoids a forward-compat issue.

ok-nick · 2026-04-02T19:46:18Z

sdk/src/builder.rs

+            .collect();
+        scoped.definition.ingredients = vec![ingredient.clone()];
+        scoped.resources = self.resources.clone();
+        scoped.definition.format = INGREDIENT_ARCHIVE_MIME.to_string();


Should we have a custom format here? It's removed in claim v2.

tmathern · 2026-04-02T21:40:17Z

sdk/src/assertions/labels.rs

+pub const ARCHIVE_METADATA: &str = "org.contentauth.archive.metadata";
+
+/// `archive:type` value for a full manifest [`Builder`](crate::Builder) working-store archive (JUMBF).
+pub const ARCHIVE_TYPE_BUILDER: &str = "builder";


Why not "workingStore"?

tmathern · 2026-04-02T21:41:15Z

sdk/src/builder.rs

+    /// distinguished from a full builder archive when reading with [`Self::add_ingredient_from_archive`].
+    ///
+    /// The exported manifest is **not** a lossless slice of the parent: it uses one cloned ingredient
+    /// and a fresh claim instance id; other ingredients are omitted.


"and a fresh claim instance id"?

tmathern · 2026-04-02T21:42:11Z

sdk/src/builder.rs

+    ///
+    /// For other `application/c2pa` stores, use [`Self::add_ingredient_from_reader`] or
+    /// [`Self::add_ingredient_from_stream`].
+    #[async_generic]


The progress report, maybe, in future, could become async?

tmathern · 2026-04-03T03:22:02Z

sdk/src/builder.rs

+        };
+
+        let archive_type = kind.archive_type_str();
+        let json = format!(


Can't serde handle that formating/json?

tmathern · 2026-04-03T03:24:26Z

sdk/src/reader.rs

+    pub(crate) fn active_archive_type(&self) -> Option<String> {
+        let manifest = self.active_manifest()?;
+        let metadata: Metadata = manifest
+            .find_assertion(crate::assertions::labels::ARCHIVE_METADATA)
+            .ok()?;
+        metadata
+            .value
+            .get("archive:type")
+            .and_then(|v: &Value| v.as_str().map(str::to_owned))
+    }


tmathern · 2026-04-03T03:25:07Z

sdk/src/builder.rs

+            .cloned()
+            .collect();
+        scoped.definition.ingredients = vec![ingredient.clone()];
+        scoped.resources = self.resources.clone();


Can we just clone the resources linked to that ingredient?

gpeacock requested review from ok-nick, scouten-adobe and tmathern and removed request for tmathern April 2, 2026 18:43

ok-nick reviewed Apr 2, 2026

View reviewed changes

tmathern reviewed Apr 2, 2026

View reviewed changes

tmathern reviewed Apr 3, 2026

View reviewed changes

Conversation

gpeacock commented Apr 2, 2026

Uh oh!

codecov bot commented Apr 2, 2026

Codecov Report

Uh oh!

codspeed-hq bot commented Apr 2, 2026

Merging this PR will not alter performance

Footnotes

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants